home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ssbevd.z / ssbevd
Encoding:
Text File  |  2002-10-03  |  6.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSBEVD - compute all the eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric band matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSBEVD( JOBZ, UPLO, N, KD, AB, LDAB, W, Z, LDZ, WORK, LWORK,
  14.                         IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, KD, LDAB, LDZ, LIWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           AB( LDAB, * ), W( * ), WORK( * ), Z( LDZ, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      SSBEVD computes all the eigenvalues and, optionally, eigenvectors of a
  39.      real symmetric band matrix A. If eigenvectors are desired, it uses a
  40.      divide and conquer algorithm.
  41.  
  42.      The divide and conquer algorithm makes very mild assumptions about
  43.      floating point arithmetic. It will work on machines with a guard digit in
  44.      add/subtract, or on those binary machines without guard digits which
  45.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  46.      conceivably fail on hexadecimal or decimal machines without guard digits,
  47.      but we know of none.
  48.  
  49.  
  50. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  51.      JOBZ    (input) CHARACTER*1
  52.              = 'N':  Compute eigenvalues only;
  53.              = 'V':  Compute eigenvalues and eigenvectors.
  54.  
  55.      UPLO    (input) CHARACTER*1
  56.              = 'U':  Upper triangle of A is stored;
  57.              = 'L':  Lower triangle of A is stored.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      KD      (input) INTEGER
  78.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  79.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  80.  
  81.      AB      (input/output) REAL array, dimension (LDAB, N)
  82.              On entry, the upper or lower triangle of the symmetric band
  83.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  84.              column of A is stored in the j-th column of the array AB as
  85.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  86.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  87.              j<=i<=min(n,j+kd).
  88.  
  89.              On exit, AB is overwritten by values generated during the
  90.              reduction to tridiagonal form.  If UPLO = 'U', the first
  91.              superdiagonal and the diagonal of the tridiagonal matrix T are
  92.              returned in rows KD and KD+1 of AB, and if UPLO = 'L', the
  93.              diagonal and first subdiagonal of T are returned in the first two
  94.              rows of AB.
  95.  
  96.      LDAB    (input) INTEGER
  97.              The leading dimension of the array AB.  LDAB >= KD + 1.
  98.  
  99.      W       (output) REAL array, dimension (N)
  100.              If INFO = 0, the eigenvalues in ascending order.
  101.  
  102.      Z       (output) REAL array, dimension (LDZ, N)
  103.              If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal
  104.              eigenvectors of the matrix A, with the i-th column of Z holding
  105.              the eigenvector associated with W(i).  If JOBZ = 'N', then Z is
  106.              not referenced.
  107.  
  108.      LDZ     (input) INTEGER
  109.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  110.              'V', LDZ >= max(1,N).
  111.  
  112.      WORK    (workspace/output) REAL array,
  113.              dimension (LWORK) On exit, if INFO = 0, WORK(1) returns the
  114.              optimal LWORK.
  115.  
  116.      LWORK   (input) INTEGER
  117.              The dimension of the array WORK.  IF N <= 1,                LWORK
  118.              must be at least 1.  If JOBZ  = 'N' and N > 2, LWORK must be at
  119.              least 2*N.  If JOBZ  = 'V' and N > 2, LWORK must be at least ( 1
  120.              + 5*N + 2*N**2 ).
  121.  
  122.              If LWORK = -1, then a workspace query is assumed; the routine
  123.              only calculates the optimal size of the WORK array, returns this
  124.              value as the first entry of the WORK array, and no error message
  125.              related to LWORK is issued by XERBLA.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  141.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  142.  
  143.      LIWORK  (input) INTEGER
  144.              The dimension of the array LIWORK.  If JOBZ  = 'N' or N <= 1,
  145.              LIWORK must be at least 1.  If JOBZ  = 'V' and N > 2, LIWORK must
  146.              be at least 3 + 5*N.
  147.  
  148.              If LIWORK = -1, then a workspace query is assumed; the routine
  149.              only calculates the optimal size of the IWORK array, returns this
  150.              value as the first entry of the IWORK array, and no error message
  151.              related to LIWORK is issued by XERBLA.
  152.  
  153.      INFO    (output) INTEGER
  154.              = 0:  successful exit
  155.              < 0:  if INFO = -i, the i-th argument had an illegal value
  156.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  157.              diagonal elements of an intermediate tridiagonal form did not
  158.              converge to zero.
  159.  
  160. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  161.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  162.  
  163.      This man page is available only online.
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.